Service Manager powered by HEAT
Using Fields
About Fields
A field is a container of information within a business object. Fields can reflect information that is entered or selected by the user. Sometimes field information is generated by the system.
After creating a field, add it to a form for viewing. On a form, a field is represented using a field control such as a checkbox, text box, or drop-down list. The field type determines which controls can be used. When a form is opened for a read-only business object, all controls except those listed in the exception list become read-only.
You can add a maximum of 256 fields to a business object. If you need to add more fields, we recommend that you create a new business object with a one-to-one relationship. If any of your existing business objects contain more than 256 fields, the system displays a warning message but lets you continue. However, we strongly recommend that you reduce the number of fields to 256. In a future release of Ivanti Service Manager, the system will not allow you to save business objects with more than 256 fields.
Viewing Fields
1.From the Configuration Console, click Build > Business Objects. The system displays the Business Objects workspace.
2.Open a business object. The system opens the workspace for the selected business object.
3.Select the Fields tab. The system displays a list of fields.
Fields Tab for the Change Business Object
The system displays the following information:
| Field | Description |
|---|---|
| Field Name | A unique name without spaces or special characters. |
| Display Name | The name that appears to users. |
| Type | The type, such as binary, Unicode text, text, integer, DateTime, short, and so on. See Form Field Types. |
| Unique |
Assigns a unique ID to a record. This ID is unique across all instances (records) in the business object table. This is the same as the unique index used in a Microsoft SQL database. |
| Nullable |
Allows a NULL value to be entered in a field. Values are not enforced in this field, but when they are defined, they must be unique (even though Unique is not checked). |
| Stored |
Stores field values in the database. When unchecked, it permits the field to be evaluated at runtime but not store its values. |
| Hidden |
Does not show this field in the Ivanti Service Manager interface. You cannot use this when creating a form. This option is typically activated by default and is of particular use in group and member business objects. |
| Searched |
Makes this field searchable. For example, number fields often produce unexpected results when performing a text search. You can check this field to make your field search correctly. An example is the IncidentNumber field in the Incident business object. |
| Indexed | Specifies that the field is part of a database index. |
| Full-text Indexed |
Text and binary fields can be full-text indexed. The system indexes unique words for fields that are marked as full-text indexed and uses them in full-text search and simple keyword search in the business object workspace.
NOTE: We recommend setting only a limited number of fields to full-text indexed, because setting too many fields can cause performance issues. |
| Audited | When selected, any changes to this field are audited in the audit stream. |
| Validated |
Uses a validation list. Select a list from the drop-down list. The field must be marked as Unicode to be used as the pick list for a validated text field. Also, the data type between the stored field in the named validation list, and a validated field, must match. For example, if the named validation list is defined against a text field, but the user is attempting to use it for a number field, the validation does not work. You can also translate values from a validated pick list. If a field is validated and the field from where it is fetching data is marked Is Localizable, then click the Values link in the Validated section, and add the translated values for the supported languages. |
Creating a Field
1.From the Configuration Console, click Build > Business Objects. The system displays the Business Objects workspace.
2.Open a business object. The system opens the workspace for the selected business object.
3.Select the Fields tab. The system displays a list of fields.
4.Click Add new.... The system displays a list of field types. See Form Field Types.
5.Select a field type. The system displays the Setting Field Details workspace.
6.Enter information in the fields. Depending on the type of field that you create, the system displays different fields. Fields unique to a field are listed under that field type; fields that are common to all fields are listed here.
| Field | Description |
|---|---|
| Field Name | A unique name without spaces or special characters. |
| Display Name | The name that appears to users. |
| Description | An optional description of the field. |
| Field Type | Automatically set by the system based on the field type that you select. You can only make changes to this value for the Number and Text field types. |
| Permissions | These permissions are set internally and cannot be configured. |
| Field Annotations | |
| Field Annotations (not used for Guid fields) |
Optional. You can select an annotation from the list to specify a field type. This is not commonly used. You can select from the following annotations: EmailAddress Url PhoneNumber OrgUnitName |
| Field Attributes | |
| Unique (not used for link fields) | Specifies if you can assign a unique ID to a record. This ID is unique across all instances (records) in the business object table. This is the same as the unique index used in a Microsoft SQL database. |
| Nullable (not used for link fields) | Specifies if you can enter a NULL value in the field. Values are not enforced in this field, but when they are defined, they must be unique (even though Unique is not checked). |
| Hidden in UI | Specifies that the system does not display this field in the user interface. If you check this, you cannot use this field when creating a form. This option is typically activated by default and is of particular use in group and member business objects. |
| Searched | Specifies if this field can be searched. For example, number fields often produce unexpected results when performing a text search. You can check this field to make your field search correctly. An example is the IncidentNumber field in the Incident business object. |
| Stored (not used for link fields) | Specifies if the system stores the value of the field in the database. If unchecked, the system evaluates the value of the field at runtime but does not store its value. |
| Audited | Specifies that changes to this field are audited in the audit stream. |
| Commonly Used | Not used. |
7.Click Save.
Form Field Types
•AsymmetricallyEncryptedString
•Guid
•Link
•Text
AsymmetricallyEncryptedString
Stores text as securely as possible. Use this field to maximize security for stored text. In contrast with symmetrically encrypted text, this text cannot be restored without an externally stored private key. Due to decryption and performance issues, use this type only when necessary.
AsymmetricallyEncryptedString fields are stored in the database in encrypted view. For encryption, asymmetric algorithm is used. Asymmetric here means that there are two parts of key: public and private. The public key can be widely known and used for encryption, but for decryption private part of key must also be known. Ivanti Service Manager stores only the public key, so that the data can only be decrypted by a user who knows the private key as well as the public key.
| Parameter | Description |
|---|---|
| Type Binding | |
|
Public Crypt Key |
Public half of an asymmetrical (public-private combination) encryption key. The private half of the key is not stored in Ivanti Service Manager. |
In the Fields workspace, this is displayed as AssymmetricallyEncryptedString.
Binary
Stores large binary files such as images.
| Parameter | Description |
|---|---|
| Binary Length | |
| Variable, max | The maximum number of characters allowed to be stored in a field entry (maximum 2000 characters allowed). |
|
Unlimited |
Allows an unlimited number of characters or bytes to display. |
| Full-Text Properties | |
| Type Column | Only used when the value of the Binary Length field is set to Unlimited. It is used for storing the document type for any document (such as an image) that is represented in binary format in the database. It contains file extensions such as .doc, .jpg, .pdf, and so on. |
| Language |
The default language to use for full-text indexes. The set of languages to choose from is from Microsoft SQL Server and therefore you cannot modify the values that are displayed here.
To change this field, under Field Attributes, ensure that Full-text Indexed is checked and Localized is unchecked. Select a new value from the drop-down list. |
| Pick List | |
| Validated |
|
| Field Attributes | |
| Full-text Indexed |
Specifies that the field is full-text indexed. The system indexes unique words for fields that are marked as full-text indexed and uses them in full-text search and simple keyword search in the business object workspace.
NOTE: We recommend setting only a limited number of fields to full-text indexed, because setting too many fields can cause performance issues. |
In the Fields workspace, this is displayed as Binary(Max) or Binary(a) where a is the value of the Variable, max parameter.
Boolean
The simplest type that allows you to store Boolean values of true or false.
| Parameter | Description |
|---|---|
| Pick List | |
| Validated |
Specifies that any pick lists that include this field are validated pick lists. |
| Pick List Name |
Only displayed if you checked Validated. |
| N/A | Only displayed if you checked Validated. |
| N/A | Only displayed if you checked Validated. |
| Is State Transition | Only displayed if you checked Validated. |
In the Fields workspace, this is displayed as Boolean.
Currency
A compound value that consists of an amount and a currency code.
| Parameter | Description |
|---|---|
| Type Binding | |
| Total Number Of Digits | Number of digits allowed in the data value. |
| Precision | The number of digits used after the decimal symbol in the data value. Zero shows only whole numbers. |
| Pick List | |
| Validated |
Specifies that any pick lists that include this field are validated pick lists. |
| Pick List Name |
Only displayed if you checked Validated. |
| N/A | Only displayed if you checked Validated. |
| N/A | Only displayed if you checked Validated. |
| Is State Transition | Only displayed if you checked Validated. |
In the Fields workspace, this is displayed as Currency(a,b) where a is the value of the Total Number Of Digits parameter and b is the value of the Precision parameter.
Date/Time
Stores date and time entries. If you store a date and a time together, internally, the system stores them as UTC but shows them to the user in the time zone associated with the user, with a few exceptions such as email and workflow. Most values consist of only a date and a time, but you can include a time zone, too.
Use this field type to store the following:
•Date
•Time
•Time zone
•Date and time
•Time and a time zone
•Date, time, and time zone
•...but not a date and time zone.
Include the time zone to store a specific time zone with a date and time. For example, to schedule an event in the time zone in which the event occurs, such as 2pm in the Eastern time zone, create a field with a time and a time zone. The result is 2pm Eastern time, instead of the corresponding time in the user's time zone.
If you include a time and a time zone, but no date, the system assumes that you are in the current half of the year, in relation to daylight savings time. For example, to schedule a meeting every day at 2pm, use this combination. The meeting stays at 2pm even after daylight savings time starts or ends.
| Parameter | Description |
|---|---|
| Type Binding | |
|
Date |
Includes the date in a DateTime field. |
|
Time |
Includes the time in a DateTime field. |
|
Time zone |
Automatically shows the time zone list. |
| Pick List | |
| Validated |
Specifies that any pick lists that include this field are validated pick lists. |
| Pick List Name |
Only displayed if you checked Validated. |
| N/A | Only displayed if you checked Validated. |
| N/A | Only displayed if you checked Validated. |
| Is State Transition | Only displayed if you checked Validated. |
In the Fields workspace, this is displayed as one of the following:
•Date: Date only
•Time: Time only
•Date/Time: Date and time only
•TimeOnlyTimeZone: Time and time zone only
•TimeZone: Date, time, and time zone
Guid
In the Fields workspace, this is displayed as Guid.
Link
Allows you to link one business object to another.
| Parameter | Description |
|---|---|
| Type Binding | |
|
Relationship |
The relationship to use for this field. You cannot set this field when you create the field. You must set the value for this field after you create a relationship with this field.
Create the field and save it. Then create a relationship using this field and save it. Then return to this page to update the field. To change the value, either click not set or click the name of the relationship. The system displays the relationships that have this link field selected as a foreign key. |
|
Restrict To |
Displays the name of the related business object when the relationship specifies a standalone business object or a member business object. When the relationship specifies a group business object as the related business object, you can restrict the relationship to a specific group.
Create the field and save it. Then create a relationship using this field and save it. Then return to this page to update the field. To change the value, click the value and select a new value from the drop-down list. |
|
Binding |
The binding type for the relationship for this field. The system automatically populates this field after you create a relationship with this field. You cannot change this value. |
| Component Fields | |
| Linked object id field | The system automatically populates this field by appending "_RecID" to the field name. You cannot change this value. |
| Linked object type field | The system automatically populates this field by appending "_Category" to the field name. You cannot change this value. |
In the Fields workspace, this is displayed as Link.
Number
Includes integers and real numbers. You can specify the precision.
| Parameter | Description |
|---|---|
| Type Binding | |
|
Total Number Of Digits |
Number of digits allowed in the data value. |
|
Precision |
The number of digits used after the decimal symbol in the data value. If you enter zero, you get an integer. |
| Pick List | |
| Validated |
Specifies that any pick lists that include this field are validated pick lists. |
| Pick List Name |
Only displayed if you checked Validated. |
| N/A | Only displayed if you checked Validated. |
| N/A | Only displayed if you checked Validated. |
| Is State Transition | Only displayed if you checked Validated. |
In the Fields workspace, this is displayed as one of the following:
•Number (a,b), where a is the value of the Total Number Of Digits parameter and b is the value of the Precision parameter.
•Integer, when the value of the Precision parameter is 0, indicating that this is a whole number.
Password
Used for passwords. Passwords themselves are not stored; the result of the hash function is stored instead. When you enter a password, the system compares the returned value of the hash function to the stored value. If they match, the password is correct.
| Parameter | Description |
|---|---|
| Type Binding | |
|
Maximum Length |
Character limit for a field entry. |
| Store hashed password | Specifies if the hashed password should be stored. |
Passwords appear as dots on the screen. See About Setting the Password Policy.
Password Options
In the Fields workspace, this is displayed as Password(a) where a is the value of the Maximum Length parameter.
SymmetricallyEncryptedString
Stores text securely. In contrast with the Password field type, it can be restored.
SymmetricallyEncryptedString fields are stored in the database in encrypted view. For encryption, symmetric algorithm is used. Symmetric here means that for encryption and decryption the same key is used. Therefore, encrypted value can be easily decrypted when needed. Since symmetric keys are stored in database and can be retrieved by experienced users, this type should be used only in scenarios when "weak" data protection could be implemented.
| Parameter | Description |
|---|---|
| Type Binding | |
|
Maximum Length |
Character limit for a field entry. |
|
Crypt Key |
Encryption key for a asymmetrically encrypted string. |
|
Encryption Algorithm |
Encryption algorithm used: Symmetrical encryption can use 0 (DES), 1 (RC2), 2 (Rijndael) and 3 (TripleDes) algorithms. Asymmetrical encryption uses only the RSA algorithm. |
In the Fields workspace, this is displayed as SymmetricallyEncryptedString.
Text
Stores text strings. This includes single and multiple rows strings up to 2000 characters length as well as huge amount of text, whose size could be up to several megabytes.
| Parameter | Description |
|---|---|
| Field Type |
Choose a type from the drop-down list. Text: Creates a plain text field. Unicode Text: Allows the field to contain non-English characters. For a Unicode text field that is marked as validated, only named validation lists with stored fields which are Unicode text fields, are shown. Similarly, regular text fields can only by validated by named validation lists, with stored fields that are regular text fields. As an example, assume there is a named validation list defined against the LoginID field in the Employee business object, that has been marked as Unicode (for example, DisplayName of employee with LoginID value by team). For it to be used as the pick list for a validated text field, the field must also be marked as Unicode, for the named validation list to show up. Also, the data type between the stored field in the named validation list, and a validated field, must match. For example, if the named validation list is defined against a text field, but the user is attempting to use it for a number field, the validation does not work. HTML: Enables HTML controls and allow users to enter HTML text. HTML fields are limited to 2 GB. See also note below. |
| Text Length | |
| Variable | Creates a field of variable length. Enter the maximum number of characters permitted. The default length is 32. The highest number allowed is 2000. |
|
Fixed |
Fixes the length of a field entry to a specified size. The field value includes padding to the right. The default length is 32. The highest number allowed is 2000. |
|
Unlimited |
Allows an unlimited number of characters or bytes to be displayed for this property. The highest number allowed is 2 GB. HTML fields should not exceed 200 MB. |
| Full-Text Properties | |
|
Type Column |
Not used. |
| Language |
The default language to use for full-text indexes. The set of languages to choose from is from Microsoft SQL Server and therefore you cannot modify the values that are displayed here.
To change this field, under Field Attributes, ensure that Full-text Indexed is checked and Localized is unchecked. Select a new value from the drop-down list. |
| Pick List | |
| Validated |
Specifies that any pick lists that include this field are validated pick lists. |
| Pick List Name |
Only displayed if you checked Validated. |
| N/A | Only displayed if you checked Validated. |
| N/A | Only displayed if you checked Validated. |
| Is State Transition | Only displayed if you checked Validated. |
| Field Attributes | |
| Localized | Specifies that you can localize the values for this field. |
| Full-text Indexed | |
In the Fields workspace, this is displayed as one of the following:
•Unicode Text(a), where a is either the value of the Variable parameter or is Max.
•Fixed Text (a), where a is the value of the Fixed parameter.
•Byte
•Text(a), where a is the value of the Variable parameter or is Max.
•Fixed Unicode Text(a), where a is the value of the Fixed parameter.
•HTML
Placing HTML (including JavaScript) into a text field and then binding it to an HTML control creates a security hole. Obviously, this is not good practice and we do not recommend this.
You can paste images into the HTML; however, each image must be 3 MB or smaller. Larger images may crash the system and affect performance.
Deleting a Field
1.From the Configuration Console, click Build > Business Objects. The system displays the Business Objects workspace.
2.Select any business object. The business object page opens.
3.Select the Fields tab. A list of fields appears.
4.Click the delete icon 
at the end of the row associated with the field to delete.
5.At the confirmation message, click Yes.
Resizing Text Fields
In Ivanti Service Manager you can resize and enlarge text fields including an HTML editor and a multiline text area. For example, you may be reviewing an incident containing multiline fields and you are not able to see all of the content due to the small area. You can enlarge the text area by dragging the corner of the box so you can take more advantage of the screen area. The system maintains this setting as you change through different settings.
1.Log in to the Service Manager Application.
2.Click Incident to open the Incident workspace.
3.Open an incident.
4.Click on the ellipse in the bottom right-hand corner of the text box to enlarge the text box.
Resizing a Text Field
Ivanti Service Manager retains the new size as you change through different incidents when you are in the same workspace.
Resizing a Pop-Up Window
The HTML editor includes a resize pop-up option in addition to a resizer. If you click on an email in the Email workspace, you can click a button to maximize the email.
1.Click Email to open the Email workspace.
2.Click any email to open it.
3.Click the button in the top right-hand corner to maximize the screen and open the email in a pop-up window.
Pop-Up Window Button
Pop-Up Window
4.Click Close to return to the email. The Close button updates all of the changes that you made in the HTML editor while working in the pop-up window.
Was this article useful?
The topic was:
Inaccurate
Incomplete
Not what I expected
Other
Copyright © 2017, Ivanti. All rights reserved.